home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr37 / ho5m.zip / GATHER.TXT < prev    next >
Text File  |  1995-03-03  |  24KB  |  558 lines
  1.  
  2.  
  3.                    The GATHER Manual           Page 1
  4.  
  5.  
  6.  
  7.  
  8.                      Version 3.01      March, 1995
  9.  
  10.  
  11.                              _______
  12.                         ____|__     |               (R)
  13.                      --|       |    |-------------------
  14.                        |   ____|__  |  Association of
  15.                        |  |       |_|  Shareware
  16.                        |__|   o   |    Professionals
  17.                      -----|   |   |---------------------
  18.                           |___|___|    Member
  19.  
  20.  
  21.  
  22.  
  23.           Gather gathers specified files from specified directories and
  24.           copies, archives, or moves, them to a destination directory.
  25.           This allows one to collect copies of crucial files, such as
  26.           the AUTOEXEC.BAT, or database files, into a central directory
  27.           for transfer to another computer as a backup and for ongoing
  28.           remote maintenance and diagnosis.  You can also use gather as
  29.           a form of ongoing BACKUP, MOVE, or ERASE program by running it
  30.           as a TSR or resident program.  When run as a TSR you can
  31.           direct GATHER to periodically gather files as specified in a
  32.           response file, or on the command line, to a specified
  33.           directory and/or a diskette.  You may discover that gather
  34.           occupies too much ram to be generally kept resident.  If so,
  35.           consider periodically using it in a batch file instead, you
  36.           should find that it is MUCH faster than other software that
  37.           you use for similar purposes.  Gather is command line
  38.           oriented, but the telemenu remote menu program provides a
  39.           mousy menuing (SAA/CUA if you prefer) alternate interface.  If
  40.           you use the resident or tsr option with the remote menu
  41.           program, you can be in a very large program like dBASE IV and
  42.           the menu program will swap dBASE out of RAM and swap itself in
  43.           when you use its hotkey.  See the TELEMENU.TXT for information
  44.           on the remote menu programs.
  45.  
  46.           Please also note that gather is designed so it CAN copy files
  47.           over themselves, which effectively destroys them.  If you wish
  48.           to avoid destroying files, do not copy them over themselves.
  49.           Please note that you can use the Query switch to make gather
  50.           ask before it acts.
  51.  
  52.  
  53.           The Gather command line:
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                    The GATHER Manual           Page 2
  61.  
  62.  
  63.  
  64.             Usage  Gather  -time -show -clock -tsr @name -fname -d\A_DIR\ ...
  65.  
  66.            -ARCHIVE Archive by default, instead of copying.
  67.            -CLOCK   to display the time.
  68.            -DAYS10  to gather files within the given number of days.
  69.            -D\DIR\  the destination directory (and file when archiving).
  70.            -ERASE   Erases files.  See also Move.
  71.            -Fname   to copy the NAMEd file.  You may use * as in *.dbf.
  72.            -H       this help.  See also the GATHER.TXT.
  73.            -MOVE    Move instead of copy files.
  74.            -N       reName copied files by inserting a number.
  75.            -PATH    to search for files along the PATH.
  76.            -Q       Query.  Ask before acting.  -Q- avoids a query.
  77.            -REDIR   for screen REDIRection to a file.
  78.            -SCATTER to (re)install a list of files, used with @filelist.
  79.            -SHOW    to show filenames during processing.
  80.            -TIME60  the repeat time or delay in seconds between file copying.
  81.            -TSR     to run as a TSR or resident program.
  82.            -UNLOAD  to unload the TSR from RAM.
  83.            [S] [R]  Send or Receive files by serial connection.
  84.            @some_file  use a response file listing the files to copy/move...
  85.  
  86.           If there is 'extra' material left on the command line after
  87.           the above checks, gather tries to use it as a destination
  88.           directory.  You can use "GATHER @FILELIST C:\SOMEDIR\".  If
  89.           you are archiving you can use "GATHER @FILELIST
  90.           C:\SOMEDIR\BACKUP" to specify that the archive filename will
  91.           be "BACKUP".
  92.  
  93.  
  94.           Gather also accepts / as the switch character instead of -.
  95.  
  96.  
  97.  
  98.           These switches are explained further below:
  99.  
  100.           -ARCHIVE to force the default behaviour to archiving instead
  101.           of copying.  This allows you to supply a response file without
  102.           [archive] at the top of the file and have gather archive
  103.           instead of trying to copy the files.  Gather actually also
  104.           accepts -ARCH.
  105.  
  106.           -DAYS10 the number of days to the oldest file to gather.  If a
  107.           file was last changed 9 days ago, and gather is run with
  108.           -DAYS10, the file will be gathered.
  109.  
  110.           -D\dir\ the destination directory.  This tells gather to copy
  111.           the file(s) to that directory.  Its a good idea to include the
  112.  
  113.  
  114.  
  115.  
  116.  
  117.                    The GATHER Manual           Page 3
  118.  
  119.  
  120.  
  121.           drive as in -dD:\TRANSFER\.  It will yell and quit if the
  122.           destination directory does not exist.  It will also yell if
  123.           the destination file is write protected, hidden, or a system
  124.           file.  Also, if there is 'extra' material left on the command
  125.           line after checking for other switches, it will be checked for
  126.           a destination directory (and filename when archiving).
  127.  
  128.           -Fname to copy the named file.  You may use * as in *.dbf.
  129.           Use this to copy a specific file, such as -fADDRESS.DBF, or a
  130.           group of files, as in -f*.DBF.  Use the @response_file method
  131.           when you want to gather more files or be more specific.  If
  132.           the source file does not exist, gather will silently continue
  133.           to the next file.
  134.  
  135.           -H this help. You may also use /H -?  and ?, or even a blank
  136.           command line.
  137.  
  138.           -N to reName copied files to minimise overwriting previous
  139.           copies.  The renaming inserts a number into the file name,
  140.           with consecutive files having a consecutive number inserted.
  141.           The seed number is based on the current second at the time of
  142.           the start of the copying.  Files ROSTER, SALARY.DBF, and
  143.           WORKS.WKS will be renamed to ROSTER.20, SALARY21.DBF, and
  144.           WORKS22.WKS if copying starts at 11:30:20.  If LASTNAME.DBF
  145.           was the 180th file copied, it would become LASTN200.DBF, since
  146.           20+180 = 200.  Numbers above 999 restart at 0.  Using this
  147.           scheme might appear attractive but it can consume disk space
  148.           rapidly.
  149.  
  150.           -PATH to search along the PATH for one or more files.  This
  151.           instruction tells gather to look through every directory along
  152.           your machine's current path for the file(s).  Some uses of
  153.           this switch are incompatible with other switches, with the
  154.           idea that if you use *.* or the like, then you do not really
  155.           mean to copy every file along the path to the destination
  156.           directory.
  157.  
  158.           -REDIR DOS screen display, to allow redirection to a file.  If
  159.           you are also using -clock, the clock will continue to write
  160.           using the bios, with the program dynamically changing screen
  161.           drivers back to dos after each time update.  A side effect of
  162.           this setting may be a change in gather colours.  The default
  163.           is to use bios output.
  164.  
  165.           -SCATTER can be considered a form of uninstall, reinstall, or
  166.           install.  For example, you might GATHER the AUTOEXEC.BAT,
  167.           CONFIG.SYS, and all the various .INI files in a computer to
  168.           one directory before installing some trial software.  The
  169.  
  170.  
  171.  
  172.  
  173.  
  174.                    The GATHER Manual           Page 4
  175.  
  176.  
  177.  
  178.           trial software might alter one or more files, but -SCATTER can
  179.           be used to replace the original files.  Gather uses a
  180.           @response_file that indicates the file's original drive and
  181.           directory with the SCATTER command.  Such a file is easily
  182.           created with DIRDBF (as in DIRDBF -path -xf *.ini for .ini
  183.           files) or with your text editor.
  184.  
  185.           -SHOW to show filenames as they are copied.  The source and
  186.           destination directories are included.
  187.  
  188.           -TIME15 the repeat or delay time between file copying.  The
  189.           default is 60, with an allowable range between 10 and 100000
  190.           seconds.  This value is the 'sleep' time for gather when it is
  191.           running as a TSR, and is the file update time when gather does
  192.           short term file copies.  Use -time60 to force gather to copy
  193.           files that have been updated in the past 60 seconds.  Note
  194.           that this is the actual tsr sleep time, it only becomes active
  195.           at the given intervals, and only for the length of time
  196.           necessary to do the given task.  If you want a longer time,
  197.           yell with an explanation, its easy to change.  You might also
  198.           consider using the @response_file method.
  199.  
  200.           -TSR to run as a TSR or resident program.  Gather takes about
  201.           100K when running as a TSR.  It is designed for speed, and
  202.           interactive use more than as a background backup program.
  203.           Gather is also designed to be very quickly and easily changed
  204.           for custom purposes.
  205.  
  206.           -UNLOAD to unload the TSR from ram.  Eg:  gather -unload
  207.  
  208.           [S] [R] to Send or Receive files by serial connection.  Gather
  209.           works with external file transfer tools.  It uses the
  210.           [transfer] section in the TELE.INI configuration file,
  211.           described below, to discover which tool to use and how to use
  212.           it.  The default Teleshare tool is XM, for xmodem 1k, which is
  213.           part of the TeleShare remote support package.  The default
  214.           HANDS ON remote access tool is the OMNI protocol, (OMI.EXE,
  215.           OMIPUT.EXE, and OMIGET.EXE) which is about as fast as zmodem,
  216.           and is quite portable.  XM is used by default because it is
  217.           very convenient, it automatically reads the TeleShare setup
  218.           information from RAM memory.  Hydracom, PCZ, Jmodem, and so
  219.           on, need more setup information.  To use the Hands On OMNI
  220.           setup you have to also use the Wizard.  XM and Hydracom accept
  221.           response files, as described immediately below.
  222.  
  223.  
  224.           @some_file to use a response file, or control file, listing
  225.           the files to copy.  You simply list the files to be copied as
  226.  
  227.  
  228.  
  229.  
  230.  
  231.                    The GATHER Manual           Page 5
  232.  
  233.  
  234.  
  235.           a list in the given text file.  A sample that includes the
  236.           autoexec.bat, config.sys and equip.log follows (equip.log is
  237.           generally used to store information about your machine, often
  238.           to be send to another machine).
  239.  
  240.           AUTOEXEC.BAT
  241.           CONFIG.SYS
  242.           EQUIP.LOG
  243.  
  244.  
  245.           The following sample adds other commands [Copy Move Erase
  246.           Archive], and comments.  They are generally used to change the
  247.           copy command to a Move or Erase command, or to reverse the
  248.           change.  Both Copy and Move should have a destination
  249.           directory on the same command line.
  250.  
  251.  
  252.           ; comments start with ; or optionally #.
  253.           ; The ; follow the .INI file comment standard.
  254.           ; The first command is to copy EQUIP.LOG to C:\BACKUP\
  255.           [Copy C:\BACKUP\]
  256.           EQUIP.LOG
  257.           ; The NAMES and ADDRESS databases will be moved to
  258.           ; D:\STORAGE\
  259.           [MOVE D:\STORAGE\]
  260.           NAMES.DBF
  261.           ADDRESS.DBF
  262.           ; next some old and backup (BAK) files will be erased
  263.           [ERASE]
  264.           oldfile
  265.           letter.bak
  266.           oldfile2
  267.           \OTHER\*.BAK ; erase all the .BAK files in \OTHER\
  268.           [archive]
  269.           new_file
  270.           newer_file
  271.           [transfer]
  272.           c:\send\*.lzh  ; send all the lha archive files
  273.  
  274.  
  275.           Please note that most programs that use response files will
  276.           not accept the additional features such as ";" and "[any]".
  277.           For example hydracom expects a simple file listing like that
  278.           produced by some filefinder tools such as dirdbf.  Our normal
  279.           practice is to use such a simple response or control file when
  280.           archiving.
  281.  
  282.           The DIRDBF tool can be used to create appropriate response
  283.  
  284.  
  285.  
  286.  
  287.  
  288.                    The GATHER Manual           Page 6
  289.  
  290.  
  291.  
  292.           files listing the files in the current directory.  Use DIRDBF
  293.           to create a FILELIST file.  Run "DIRDBF -h" to get an idea how
  294.           it works.
  295.  
  296.  
  297.  
  298.           The TELE.INI configuration file
  299.  
  300.           The TELE.INI configuration file is designed to be used by some
  301.           TELEshare tools.  Gather uses the [TRANSFER] section which
  302.           will have a structure something like the following:
  303.  
  304.           [TRANSFER]
  305.           archiver = PKZIP -u   ;  your archiver with switch(es)
  306.           backup_directory = C:\BACKUPS ; central backup directory
  307.           send=XM S %1  ; xm is the default, but you can change it.
  308.                   ; %1 locates the filename(s) to be transferred.
  309.                   ; Change it to OMI for the OMNI protocol, or hydracom
  310.                   ; or DSZ for Omen's zmodem package.
  311.           receive=XM R  ; use none to disallow file transfers
  312.           feed=no       ; yes would feed response file lines one at a
  313.                         ; time to the 'send' file transfer tool
  314.           copy=yes      ; could be none or no
  315.           move=yes
  316.           erase=yes
  317.           query=yes
  318.  
  319.           All of the commands are considered to be insensitive to case.
  320.           You can use either capitals or lowercase, unless you change
  321.           the file transfer tool to another tool that expects only one
  322.           case.
  323.  
  324.           Archiver is your preferred archiver, such as PKZIP or LHA with
  325.           the appropriate switch(es).
  326.  
  327.           Backup_directory is for a central backup directory where
  328.           archives are created.  Its a good idea to create the archive
  329.           files then copy them to diskettes or over the 'phone line.  It
  330.           also creates a third backup copy of your information.
  331.  
  332.           The program after 'send=' is the file transfer tool and
  333.           protocol for sending.
  334.  
  335.           The program after 'receive=' is the setup for receiving over
  336.           the 'phone line.
  337.  
  338.           Feed indicates whether gather should feed the transfer
  339.           instructions to the file transfer tool one line at a time, or
  340.  
  341.  
  342.  
  343.  
  344.  
  345.                    The GATHER Manual           Page 7
  346.  
  347.  
  348.  
  349.           just give it the whole file to use, as a response or control
  350.           file.  Both XM and hydracom can take the entire file if you do
  351.           not mix copy, move, or erase commands into the file.
  352.           Generally, its a good idea to set feed=no or feed=none for XM,
  353.           because it also knows how to ignore copy/move/erase commands
  354.           that it finds in files.  Do the same for hydracom and other
  355.           transfer software if you know that the input file has no
  356.           problem causing commands in it.
  357.  
  358.           Copy, move, and erase are for normal same machine file
  359.           copying, moving, and erasing.
  360.  
  361.           Query is the file query switch.  Adding it on the command line
  362.           will tell gather to ask you before copying/moving/erasing.  If
  363.           you set "query=none", this will turn-off the the command line
  364.           "-Q" command globally.  Use -Q- to deliberately turn it off.
  365.           The January, 1994 Gather has query defaulting to on.  Earlier
  366.           versions defaulted to off.
  367.  
  368.           These switches are global in that they 'overpower' any command
  369.           line commands that you might use, as a form of security.  They
  370.           allow you to setup gather to restrict file
  371.           copying/moving/erasing/transfer both by itself and while using
  372.           TeleShare.
  373.  
  374.  
  375.           Filename macros
  376.  
  377.           Gather recognises two macros:  $(DAY) and $(HOUR) mainly for
  378.           backup filenames.  So "BAK$(DAY)$(HOUR)" will become BAK2510
  379.           if the filename is created on the 25th day of the month at 10
  380.           AM.  If you are archiving it might become BAK2510.ZIP or
  381.           whatever.
  382.  
  383.  
  384.           Other checks:
  385.  
  386.           This version of gather does disk space checking, but does not
  387.           check the destination for sufficient space to copy a file.  It
  388.           uses a 'fast write' to the bios, instead of using DOS or
  389.           direct screen writing.  Use -redir for DOS screen output.
  390.  
  391.           P.C Softsmith distributes an interactive TOUCH program that
  392.           allows you to alter the time and date of any file to any other
  393.           time and date, which can be useful when used for software
  394.           development and for 'backups' with gather.  Ask for it.
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.                    The GATHER Manual           Page 8
  403.  
  404.  
  405.  
  406.           SUPPORT
  407.  
  408.  
  409.           For technical support, either call (604) 433-5189, or write to
  410.           Suite 606 - 6455 Willingdon Avenue, Burnaby, British Columbia,
  411.           Canada, V5H 4E4.  Both registered and soon to be registered
  412.           users currently get the same support without any arbitrary
  413.           time limit.  You may also try leaving a Compuserve message at
  414.           75020, 2664, or better yet send email to
  415.  
  416.           INTERNET:vic_williams@mindlink.bc.ca
  417.  
  418.  
  419.           P.C. Softsmith                       (604) 433-5189
  420.           Suite 606 - 6455 Willingdon Avenue,
  421.           Burnaby, British Columbia,
  422.           Canada, V5H 4E4
  423.  
  424.  
  425.           Please consider reporting the circumstances of ANY problems
  426.           that you discover, preferably in written form, to technical
  427.           support.
  428.  
  429.  
  430.           Some possible problems:
  431.  
  432.           The TSR option will not run after MSWindows is running. If you
  433.           must do this, ask for such a version, or just run it ahead of
  434.           Windows.  It can be reset to do so, but it will then be
  435.           unusually agressive running under DOS.
  436.  
  437.           You might possibly create a situation where gather runs out of
  438.           internal memory.  Gather has the capability to have such
  439.           memory usage altered at start-up, but this version does not
  440.           include such a command line switch.  Yell if you find such a
  441.           need.
  442.  
  443.           The -SHOW option overwrites your program's screen.  Sorry, but
  444.           the other options would require delays so humans could see the
  445.           message.  Try avoiding the -SHOW option in such a case.
  446.  
  447.           The clock appears in the wrong place.  Please wait for a
  448.           version using the TELE.INI configuration file.
  449.  
  450.           It repeatedly copies the same file to the backup directory.
  451.           Yes, if you are using the -days option, it is following your
  452.           instructions.
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.                    The GATHER Manual           Page 9
  460.  
  461.  
  462.  
  463.           It takes too much memory away from my usual applications.  Try
  464.           running it in a batch file during gaps in your work.  There
  465.           are some nifty small background TSR backup programs around.
  466.  
  467.           It does not check the available destination disk space before
  468.           copying a file.  If you believe that this is a major problem,
  469.           please indignantly say so, in order to encourage its addition
  470.           to the next release.  From a software developer's viewpoint
  471.           this is the start of adding an unlimited number of features
  472.           with the next likely feature being to add priorities for
  473.           copying individual files.  A complication is that such ongoing
  474.           backups often overwrite previous copies of the same file, so a
  475.           simple disk space check is not sufficient.
  476.  
  477.  
  478.           This product is Copyright (C) 1993-4 P. C. Softsmith all
  479.           rights reserved.  It is distributed as shareware and must be
  480.           distributed with this documentation.  It is normally
  481.           distributed with other P.C. Softsmith materials that further
  482.           explain the shareware process.  If you wish to distribute it
  483.           with your software or are unable to find the other
  484.           documentation that should accompany this file (such as the
  485.           SHR_WARE.TXT, FILE_ID.DIZ, and the VENDOR.TXT) please contact
  486.           whoever gave you the software or P.C. Softsmith. If you just
  487.           want to use this product on its own, you may license its use
  488.           for $US 10.00.
  489.  
  490.           History: (by date & version)
  491.  
  492.           November, 1994
  493.           3.01 fixed problem with DOS find_first/find_next functions
  494.           August 3, 1994
  495.           3.00 Added $(DAY) and $(HOUR) macros
  496.           July 19, 1994
  497.           3.00  Added archiving capability.
  498.           July 14, 1994
  499.           2.52  Correction/update:  The Hands On OMNI setup uses
  500.           the Wizard but not a response file.  Minor usage changes.
  501.           June 7, 1994
  502.           2.51  minor changes to this manual.
  503.           April 5, 1994
  504.           2.51  Documentation changes for the HANDS ON remote
  505.           access OMNI protocol.
  506.           March 18, 1994
  507.           2.5 version change to match Teleshare.  There is now a
  508.           Teleshare Gather distribution specifically for remote and
  509.           local file management.
  510.           March, 1994
  511.  
  512.  
  513.  
  514.  
  515.  
  516.                    The GATHER Manual           Page 10
  517.  
  518.  
  519.  
  520.           2.1 minor changes but Teleshare remote menu program mentioned
  521.           in the manual.
  522.           December, 1993
  523.           2.1 improves file attribute checking for read only files etc.
  524.           2.0  uses the TELE.INI file for copy, move, erase, the [R][S]
  525.           file transfer capability, and the optional Query switch.
  526.           November, 1993
  527.           1.10 improved wild card (*) handling and PATH support.
  528.           1.01 adds the -N rename switch and a larger stack.
  529.           1.00 was released in June, 1993.
  530.  
  531.           ASP Introduction:
  532.  
  533.           Please also carefully read the accompanying SHR_WARE.TXT
  534.           document.
  535.  
  536.           "This program is produced by a member of the Association of
  537.           Shareware Professionals (ASP). ASP wants to make sure that the
  538.           shareware principle works for you. If you are unable to
  539.           resolve a shareware-related problem with an ASP member by
  540.           contacting the member directly, ASP may be able to help. The
  541.           ASP Ombudsman can help you resolve a dispute or problem with
  542.           an ASP member, but does not provide technical support for
  543.           members' products. Please write to the ASP Ombudsman at 545
  544.           Grover Road, Muskegon, MI 49442 or send a CompuServe message
  545.           via CompuServe Mail to ASP Ombudsman 70007,3536."
  546.  
  547.  
  548.           THE DOCUMENTATION AND ASSOCIATED SOFTWARE ARE DISTRIBUTED AND
  549.           SOLD WITH NO WARRANTIES, EITHER EXPRESS OR IMPLIED, REGARDING
  550.           ITS MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE.
  551.           THE INFORMATION IN THIS DOCUMENTATION IS SUBJECT TO CHANGE
  552.           WITHOUT NOTICE AND DOES NOT REPRESENT A COMMITTMENT ON THE
  553.           PART OF THE VENDOR.
  554.  
  555.           OTHER PRODUCT AND BRAND NAMES MENTIONED ARE TRADEMARKS OR
  556.           REGISTERED TRADEMARKS OF THEIR RESPECTIVE HOLDERS.
  557.  
  558.